metrics: add WAL checkpoint metrics #209
Conversation
Add metrics for the WAL checkpoint pages for each database.
Log output:
```
info: WAL checkpoint {"class":"StandaloneSqliteDatabase","dbName":"data","timestamp":"2024-09-24T14:22:13.957Z","walCheckpoint":{"busy":0,"checkpointed":0,"log":0}}
```
Metric output:
```
sqlite_wal_checkpoint_pages{db="data",type="busy"} 0
sqlite_wal_checkpoint_pages{db="data",type="checkpointed"} 0
sqlite_wal_checkpoint_pages{db="data",type="log"} 0
```
|
Caution Review failedThe pull request is closed. WalkthroughWalkthroughThe changes involve updates to the Changes
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #209 +/- ##
===========================================
+ Coverage 70.09% 70.19% +0.10%
===========================================
Files 32 32
Lines 7877 7905 +28
Branches 429 430 +1
===========================================
+ Hits 5521 5549 +28
Misses 2356 2356 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (1)
src/metrics.ts (1)
133-137: LGTM! Consider enhancing the help text.The implementation of
sqliteWalCheckpointPagesas a Gauge metric is appropriate and aligns well with the PR objectives. The metric name and labels are well-chosen to represent WAL checkpoint pages for each database.Consider enhancing the help text to provide more context:
- help: 'Number of pages in the WAL', + help: 'Number of pages in the Write-Ahead Log (WAL) checkpoint for SQLite databases',This change would make the metric's purpose clearer to users who may not be familiar with the specific context of your application.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- src/database/standalone-sqlite.ts (3 hunks)
- src/metrics.ts (1 hunks)
Additional context used
Biome
src/database/standalone-sqlite.ts
[error] 2353-2353: The function should not return a value because its return type is void.
The function is here:
'void' signals the absence of value. The returned value is likely to be ignored by the caller.
(lint/correctness/noVoidTypeReturn)
[error] 3137-3137: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.The declaration is defined in this switch clause:
Unsafe fix: Wrap the declaration in a block.
(lint/correctness/noSwitchDeclarations)
Additional comments not posted (1)
src/database/standalone-sqlite.ts (1)
2976-2994: Ensure proper typing and handling ofwalCheckpointIn the
cleanupWalmethod, thewalCheckpointobject returned might not have the expected properties (busy,log,checkpointed). Ensure that these properties exist before using them.Run the following script to confirm the structure of
walCheckpoint:Review the SQLite documentation to confirm the structure of the returned value from
pragma('wal_checkpoint')and adjust the code accordingly.
The function on the worker now returns a value so we can record metrics in the parent.
We want to return a promise so callers can await on it if desired.
Add metrics for the WAL checkpoint pages for each database.
Log output:
Metric output: